---
title: clsClaimListGenerator
summary: API reference for clsClaimListGenerator.
status: draft
owner: SAIF Documentation Generator
last_reviewed: 2026-08-21
library: SAIF.Business.Claim
reference_type: embedded
---

# clsClaimListGenerator

`clsClaimListGenerator` executes a caller-supplied SQL statement in full to build an ad-hoc claim list, deliberately declining to implement any of the standard BOF SQL properties (see [Dynamic claim list generation](../../operations/claim-list-generation.md)).

## Purpose
- Provides `GetClaimListCollection` as the sole entry point for retrieving a caller-defined claim list ([SQL-019](../../sql/SQL-019.md)).
- Exposes configurable alias properties so callers can map arbitrary result columns to claim identity fields.

## Context
- Namespace: `SAIF.Business.Claim`
- Assembly/package: `SAIF.Business.Claim.dll`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `GetClaimListCollection` | `Public Shared Function GetClaimListCollection(dataPortalInfo As IDataPortalInfo, sqlStatement As String, id As Decimal, Optional requestId As Decimal) As clsClaimListGeneratorCollection` | Executes the caller-supplied `sqlStatement` with a single `:ID` bind parameter and returns the mapped result collection ([SQL-019](../../sql/SQL-019.md)). |
| `ClaimIDSQLItem` | `Public Property ClaimIDSQLItem As String` | Configurable column-alias used to map a result column to the claim ID. |
| `ClaimNumberSQLItem` | `Public Property ClaimNumberSQLItem As String` | Configurable column-alias used to map a result column to the claim number. |
| `ClaimChkCharValueSQLItem` | `Public Property ClaimChkCharValueSQLItem As String` | Configurable column-alias used to map a result column to the claim check-character value. |
| `WorkerIDSQLItem` | `Public Property WorkerIDSQLItem As String` | Configurable column-alias used to map a result column to the worker ID. |

## Behavioral notes
- All five `IBusinessCriteria` SQL properties throw `ApplicationException(clsConstants.Messages.InvalidSQLProperty)` — this type only supports the caller-supplied-SQL execution path.
- The caller-supplied SQL statement and single `:ID` bind parameter represent a SQL-injection and maintainability risk whose actual exposure depends on callers, none of which exist in this repository.*

## Constraints and usage notes
- Do not attempt standard BOF create/retrieve/update/delete semantics on this type; use `GetClaimListCollection` exclusively.

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Related documentation
- [Library index](../../index.md)
- [API reference index](../index.md)
- [Overview](../../overview.md)
- [Architecture](../../architecture.md)
- [Dependencies](../../dependencies.md)
- [Operations and processes](../../operations-processes.md)
- [Business rules](../../business-rules.md)
- [Database tables](../../database-tables.md)
- [SQL catalog](../../sql/index.md)
## Sources
- SAIF.Business.Claim/clsClaimListGenerator.vb